CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / All Operations Resource Group / /projects/{projectId}/historianConnections (Post)
In This Topic
    Post/projects/{projectId}/historianConnections
    In This Topic
    Description
    Creates or updates an array of historian connections in the project
    Parameters
    NameDescriptionData Type
    the id of the projectstring
    Request (application/json)

    The request body is of type object.

    Overview

    HistorianConnections : Array[CimHistorianConnection]
    ConnectonID : string
    The Id of historian connection.
    ServerName : string
    The server that the connection will connect to.
    Description : string
    The desciption of the connection.
    UserID : string
    The user ID the connection is made with.
    Passsword : string
    The password the connection is made with. This password will not be in get responses. It may be in create/update requests.
    UsesIdentity : boolean
    set it to true to specify user name and password.
    200 Response

    The response body is of type ItemsPostResponse.

    The collection of results from the historian connection create/update operation

    Overview

    ItemsPostResponse
    The results of the create/update/delete operations.
    NumSuccesses : number
    The number of items that were successfully written.
    NumFailures : number
    The number of items that failed to be written.
    WarningsMask : integer
    a bitmask of warning conditions (e.g., WarningLicensePointCount)
    ItemResults : Array[ItemResult]
    The results for each item in the request array.
    Success : boolean
    high level result (success true, failure false)
    StatusDetails : integer
    a value giving more details about the status (e.g., SuccessNew, SuccessModified, FailureDupInRequest, FailureDupInObject, and then a bunch of FailureXyzzy, ...)
    WarningsMask : integer
    a bitmask of warning conditions (e.g., IE_SNF_NO_GLB_TRIG_MSG)
    Message : string
    (localized?) message about the result, probably empty for successes
    Fault Responses
    FaultDescription
    This fault returns a response body of type ProblemDetails.
    Error if objects not found
    This fault returns a response body of type ProblemDetails.
    General error
    See Also